cs-invoice-processing-sapi icon

cs-invoice-processing-sapi

(0 reviews)

📚 Data Dictionary - CS Utilities System API Service

This section provides the meaning of the attributes included in the API.


💂️ Base Information


🔑 API KEYS

  • "Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.
    • Type: String
    • Length: Minimum 36 characters, maximum 37 characters
    • Description: Authentication token required to access the API.
  • "client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.
    • Type: String
    • Length: Minimum 32 characters, maximum 36 characters
    • Description: Unique client identifier to authenticate the request.

NOTE: It is important to have these API KEYS to make any request to our services.


Core Policy Issuance (POST /Services/v1/CorePolicyIssuance)

  • "policyNumber"
    • Type: String
    • Length: Max 20 characters
    • RegEx: [A-Za-z0-9-]
    • Description: Unique identifier for the policy being issued.
  • "insuredName"
    • Type: String
    • Length: Max 100 characters
    • RegEx: [A-Za-z0-9 ]
    • Description: Full name of the insured individual or entity.
  • "effectiveDate"
    • Type: String (Date Format: YYYY-MM-DD)
    • Description: Start date of the policy coverage.
  • "expiryDate"
    • Type: String (Date Format: YYYY-MM-DD)
    • Description: End date of the policy coverage.
  • "premiumAmount"
    • Type: Number (Decimal)
    • Description: Total premium amount to be paid for the policy.
  • "currency"
    • Type: String
    • Length: 3 characters
    • RegEx: [A-Z]{3}
    • Description: Currency code in ISO 4217 format (e.g., USD, EUR).

📊 Common Parameters

ParameterTypeDescriptionRequired
client_idstringUnique identifier for API clients
AuthorizationstringBearer token for secure access
policyNumberstringPolicy identifier
insuredNamestringName of the insured
effectiveDatestringPolicy start date
expiryDatestringPolicy end date
premiumAmountnumberTotal premium amount
currencystringCurrency code

🔒 Security Schemes

Client ID Enforcement

FieldTypeRequiredLength (characters)RegEx
client_idStringYes32 - 36[a-zA-Z0-9]
client_secretStringYes32 - 64[a-zA-Z0-9]

OAuth 2.0

FieldTypeRequiredLength (characters)RegEx
AuthorizationStringYes36 - 37[a-zA-Z0-9-_.]

⚠️ Common Error Codes

CodeDescriptionSuggested Solution
400Bad RequestVerify the request structure.
401UnauthorizedCheck the authentication credentials.
404Not FoundEnsure the endpoint is correct.
500Internal Server ErrorTry again later or contact support.

📞 Support

For any questions or issues, please contact the API support team INTEGRATION SERVICES AND APPLICATIONS COORDINATION.

Notes

  • Documentation adjusted in February 2025.
  • For additional information, contact: epalma@fgs.co

Reviews